// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

package org.apache.doris.nereids.pattern;

import org.apache.doris.nereids.trees.plans.Plan;
import org.apache.doris.nereids.trees.plans.PlanType;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;

import java.util.Set;

/**
 * Pattern to match a subtree.
 * Match a subtree of plan, plan nodes in the matched result are the subset of specified plan types when
 * declare the pattern.
 */
public class SubTreePattern<TYPE extends Plan> extends Pattern<TYPE> {
    private final Set<Class<? extends Plan>> subTreeNodeTypes;

    public SubTreePattern(Class<? extends Plan>... subTreeNodeTypes) {
        super(PlanType.UNKNOWN, ImmutableList.of());
        this.subTreeNodeTypes = ImmutableSet.copyOf(subTreeNodeTypes);
    }

    @Override
    public boolean matchRoot(Plan plan) {
        return plan != null && subTreeNodeTypes.contains(plan.getClass());
    }
}
